Saltar al contenido principal
GET
/
fulfillment
/
{id}
Obtener opción de fulfillment
curl --request GET \
  --url https://api.example.com/fulfillment/{id}
{
  "data": {
    "id": "delivery",
    "uid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "organization_id": "f1e2d3c4-b5a6-7890-fedc-ba0987654321",
    "merchant_id": "c1d2e3f4-a5b6-7890-cdef-123456789abc",
    "name": "Delivery",
    "type": "DELIVERY",
    "status": "ACTIVE"
  }
}
Devuelve una opción de fulfillment para el comercio autenticado. Usa este endpoint cuando ya conoces el id externo y necesitas el nombre, código de tipo y estado actuales sin listar todas las opciones.
Requiere un access token con el scope fulfillment:read. Consulta Autorizar para obtener un token.

Solicitud

Reemplaza {id} con el identificador externo de fulfillment.
curl "https://firespark.vercel.app/api/integrations/v1/fulfillment/delivery" \
  -H "Authorization: Bearer ACCESS_TOKEN"

Respuesta

La respuesta envuelve un objeto de fulfillment en data.
{
  "data": {
    "id": "delivery",
    "uid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "organization_id": "f1e2d3c4-b5a6-7890-fedc-ba0987654321",
    "merchant_id": "c1d2e3f4-a5b6-7890-cdef-123456789abc",
    "name": "Delivery",
    "type": "DELIVERY",
    "status": "ACTIVE"
  }
}

Parámetros de ruta

ParámetroTipoDescripción
idstringIdentificador externo de fulfillment. Solo caracteres alfanuméricos, _ y -. 1–64 caracteres. Único por comercio.

Objeto fulfillment

CampoTipoDescripción
idstringIdentificador externo de fulfillment. Coincide con el parámetro de ruta.
uidstring (UUID)Identificador interno de Fire spark.
organization_idstring (UUID)Organización propietaria del comercio.
merchant_idstring (UUID)Comercio al que pertenece la opción de fulfillment.
namestringNombre para mostrar. 1–100 caracteres.
typestringCódigo del tipo de fulfillment. 1–100 caracteres. Valores comunes: DELIVERY, PICKUP, DINE_IN. También se admiten códigos personalizados.
statusstringACTIVE o INACTIVE.

Respuestas de error

EstadoDescripción
401Access token ausente o inválido.
403El token no incluye el scope fulfillment:read.
404No existe una opción de fulfillment con el id indicado.